package org.tigris.scarab.pipeline;

/* ================================================================
 * Copyright (c) 2001 Collab.Net.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * 3. The end-user documentation included with the redistribution, if
 * any, must include the following acknowlegement: "This product includes
 * software developed by Collab.Net <http://www.Collab.Net/>."
 * Alternately, this acknowlegement may appear in the software itself, if
 * and wherever such third-party acknowlegements normally appear.
 * 
 * 4. The hosted project names must not be used to endorse or promote
 * products derived from this software without prior written
 * permission. For written permission, please contact info@collab.net.
 * 
 * 5. Products derived from this software may not use the "Tigris" or 
 * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without 
 * prior written permission of Collab.Net.
 * 
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Collab.Net.
 */ 

import java.io.IOException;

import org.apache.turbine.RunData;
import org.apache.turbine.Turbine;
import org.apache.turbine.TurbineException;
import org.apache.turbine.ValveContext;
import org.apache.turbine.pipeline.AbstractValve;
import org.tigris.scarab.util.ComponentLocator;

/**
 * This valve determines the charset to use when parsing request parameters.
 * It is identical to {@link DetermineCharsetValve} except it is usable under
 * servlet 2.2 libraries.
 *
 * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
 * @version $Id: DetermineCharsetValve22.java 9286 2004-12-03 12:10:28Z dep4b $
 */
public class DetermineCharsetValve22 
    extends AbstractValve
{

    private static String REQUIRED_CHARSET;

    public void initialize() throws Exception{
        super.initialize();
        REQUIRED_CHARSET = Turbine.getConfiguration().
        getString("locale.default.charset",null);
    }
    
    /**
     * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
     */
    public void invoke(RunData data, ValveContext context)
        throws IOException, TurbineException
    {
        // if we are forcing a particular charset, use it.  Hopefully
        // client has encoded for this default. This is the same 
        // property that will force the charset in our responses.
        String encoding = REQUIRED_CHARSET;   

        if (encoding == null) 
        {
            // guess the charset from the client's headers
            encoding = ComponentLocator.getMimeTypeService().getCharSet(data.getLocale());
        }

        // if the charset was specified in the configuration or the charset
        // map contained a value for the locale, set it, otherwise leave
        // it as the servlet engine has set it.
        if (encoding != null) 
        {
            // data.getRequest().setCharacterEncoding(encoding);
            data.setCharSet(encoding);
        }
        
        // Pass control to the next Valve in the Pipeline
        context.invokeNext(data);
    }
}
